<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="keep_v1.html">Google Keep API</a> . <a href="keep_v1.notes.html">notes</a> . <a href="keep_v1.notes.permissions.html">permissions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#batchCreate">batchCreate(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates one or more permissions on the note. Only permissions with the `WRITER` role may be created. If adding any permission fails, then the entire request fails and no changes are made.</p>
<p class="toc_element">
  <code><a href="#batchDelete">batchDelete(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes one or more permissions on the note. The specified entities will immediately lose access. A permission with the `OWNER` role can't be removed. If removing a permission fails, then the entire request fails and no changes are made. Returns a 400 bad request error if a specified permission does not exist on the note.</p>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="batchCreate">batchCreate(parent, body=None, x__xgafv=None)</code>
  <pre>Creates one or more permissions on the note. Only permissions with the `WRITER` role may be created. If adding any permission fails, then the entire request fails and no changes are made.

Args:
  parent: string, The parent resource shared by all Permissions being created. Format: `notes/{note}` If this is set, the parent field in the CreatePermission messages must either be empty or match this field. (required)
  body: object, The request body.
    The object takes the form of:

{ # The request to add one or more permissions on the note. Currently, only the `WRITER` role may be specified. If adding a permission fails, then the entire request fails and no changes are made.
  &quot;requests&quot;: [ # The request message specifying the resources to create.
    { # The request to add a single permission on the note.
      &quot;parent&quot;: &quot;A String&quot;, # Required. The parent note where this permission will be created. Format: `notes/{note}`
      &quot;permission&quot;: { # A single permission on the note. Associates a `member` with a `role`. # Required. The permission to create. One of Permission.email, User.email or Group.email must be supplied.
        &quot;deleted&quot;: True or False, # Output only. Whether this member has been deleted. If the member is recovered, this value is set to false and the recovered member retains the role on the note.
        &quot;email&quot;: &quot;A String&quot;, # The email associated with the member. If set on create, the `email` field in the `User` or `Group` message must either be empty or match this field. On read, may be unset if the member does not have an associated email.
        &quot;family&quot;: { # Describes a single Google Family. # Output only. The Google Family to which this role applies.
        },
        &quot;group&quot;: { # Describes a single Group. # Output only. The group to which this role applies.
          &quot;email&quot;: &quot;A String&quot;, # The group email.
        },
        &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name.
        &quot;role&quot;: &quot;A String&quot;, # The role granted by this permission. The role determines the entity’s ability to read, write, and share notes.
        &quot;user&quot;: { # Describes a single user. # Output only. The user to whom this role applies.
          &quot;email&quot;: &quot;A String&quot;, # The user&#x27;s email.
        },
      },
    },
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response for creating permissions on a note.
  &quot;permissions&quot;: [ # Permissions created.
    { # A single permission on the note. Associates a `member` with a `role`.
      &quot;deleted&quot;: True or False, # Output only. Whether this member has been deleted. If the member is recovered, this value is set to false and the recovered member retains the role on the note.
      &quot;email&quot;: &quot;A String&quot;, # The email associated with the member. If set on create, the `email` field in the `User` or `Group` message must either be empty or match this field. On read, may be unset if the member does not have an associated email.
      &quot;family&quot;: { # Describes a single Google Family. # Output only. The Google Family to which this role applies.
      },
      &quot;group&quot;: { # Describes a single Group. # Output only. The group to which this role applies.
        &quot;email&quot;: &quot;A String&quot;, # The group email.
      },
      &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name.
      &quot;role&quot;: &quot;A String&quot;, # The role granted by this permission. The role determines the entity’s ability to read, write, and share notes.
      &quot;user&quot;: { # Describes a single user. # Output only. The user to whom this role applies.
        &quot;email&quot;: &quot;A String&quot;, # The user&#x27;s email.
      },
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="batchDelete">batchDelete(parent, body=None, x__xgafv=None)</code>
  <pre>Deletes one or more permissions on the note. The specified entities will immediately lose access. A permission with the `OWNER` role can&#x27;t be removed. If removing a permission fails, then the entire request fails and no changes are made. Returns a 400 bad request error if a specified permission does not exist on the note.

Args:
  parent: string, The parent resource shared by all permissions being deleted. Format: `notes/{note}` If this is set, the parent of all of the permissions specified in the DeletePermissionRequest messages must match this field. (required)
  body: object, The request body.
    The object takes the form of:

{ # The request to remove one or more permissions from a note. A permission with the `OWNER` role can&#x27;t be removed. If removing a permission fails, then the entire request fails and no changes are made. Returns a 400 bad request error if a specified permission does not exist on the note.
  &quot;names&quot;: [ # Required. The names of the permissions to delete. Format: `notes/{note}/permissions/{permission}`
    &quot;A String&quot;,
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>

<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

</body></html>